Skip to content

docs: document Mockolate#828

Merged
vbreuss merged 7 commits intomainfrom
topic/document-mockolate
Nov 1, 2025
Merged

docs: document Mockolate#828
vbreuss merged 7 commits intomainfrom
topic/document-mockolate

Conversation

@vbreuss
Copy link
Copy Markdown
Member

@vbreuss vbreuss commented Nov 1, 2025

This PR integrates Mockolate documentation into the aweXpect documentation site by adding a dedicated section with its own sidebar navigation. The changes update Docusaurus dependencies to version 3.9.2 and reconfigure the documentation build pipeline to handle Mockolate as a special case separate from other extensions.

Key changes:

  • Adds Mockolate as a top-level navigation item with dedicated sidebar
  • Updates Docusaurus packages from 3.9.1 to 3.9.2
  • Refactors documentation download logic to support different directory structures

@vbreuss vbreuss self-assigned this Nov 1, 2025
@vbreuss vbreuss added the documentation Improvements or additions to documentation label Nov 1, 2025
Copilot AI review requested due to automatic review settings November 1, 2025 15:02
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR integrates Mockolate documentation into the aweXpect documentation site by adding a dedicated section with its own sidebar navigation. The changes update Docusaurus dependencies to version 3.9.2 and reconfigure the documentation build pipeline to handle Mockolate as a special case separate from other extensions.

  • Adds Mockolate as a top-level navigation item with dedicated sidebar
  • Updates Docusaurus packages from 3.9.1 to 3.9.2
  • Refactors documentation download logic to support different directory structures

Reviewed Changes

Copilot reviewed 7 out of 9 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
package-lock.json Adds new lockfile for npm package management
aweXpect.sln.DotSettings Adds "mockolate" to ReSharper custom dictionary
Pipeline/Build.Pages.cs Refactors download logic to support Mockolate in separate directory structure
Docs/pages/sidebars.ts Adds mockolateSidebar configuration for dedicated Mockolate navigation
Docs/pages/package.json Updates Docusaurus dependencies from 3.9.1 to 3.9.2
Docs/pages/docusaurus.config.ts Replaces benchmarks nav item with Mockolate sidebar link
Docs/pages/docs/extensions/project/Mockolate/category.json Defines Mockolate category configuration for extensions section
Docs/pages/docs/extensions/project/Mockolate/00-index.md Adds Mockolate extension documentation index page

Comment thread Docs/pages/docs/extensions/project/Mockolate/00-index.md
Comment thread Pipeline/Build.Pages.cs Outdated
Comment thread Pipeline/Build.Pages.cs
Comment thread Docs/pages/sidebars.ts Outdated
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 1, 2025

Test Results

    14 files      14 suites   4m 4s ⏱️
17 959 tests 17 957 ✅ 2 💤 0 ❌
50 511 runs  50 509 ✅ 2 💤 0 ❌

Results for commit 65f65d8.

♻️ This comment has been updated with latest results.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 1, 2025

🚀 Benchmark Results

Details

BenchmarkDotNet v0.14.0, Ubuntu 24.04.3 LTS (Noble Numbat)
AMD EPYC 7763, 1 CPU, 4 logical and 2 physical cores
.NET SDK 8.0.415
[Host] : .NET 8.0.21 (8.0.2125.47513), X64 RyuJIT AVX2

Job=InProcess Toolchain=InProcessEmitToolchain IterationCount=15
LaunchCount=1 WarmupCount=10

Method Mean Error StdDev Gen0 Gen1 Allocated
Bool_aweXpect 288.0 ns 2.41 ns 2.25 ns 0.0424 - 712 B
Bool_FluentAssertions 258.0 ns 2.93 ns 2.60 ns 0.0567 - 952 B
Equivalency_aweXpect 311,029.5 ns 802.63 ns 670.23 ns 20.0195 0.4883 335372 B
Equivalency_FluentAssertions 2,232,822.9 ns 8,400.92 ns 7,858.22 ns 273.4375 46.8750 4584416 B
Int_GreaterThan_aweXpect 275.0 ns 7.99 ns 7.47 ns 0.0486 - 816 B
Int_GreaterThan_FluentAssertions 250.5 ns 3.25 ns 2.53 ns 0.0730 - 1224 B
ItemsCount_AtLeast_aweXpect 450.0 ns 4.29 ns 3.58 ns 0.0772 - 1296 B
ItemsCount_AtLeast_FluentAssertions 510.6 ns 9.36 ns 8.75 ns 0.1192 - 2008 B
String_aweXpect 436.0 ns 2.29 ns 2.14 ns 0.0629 - 1056 B
String_FluentAssertions 1,223.6 ns 18.74 ns 17.53 ns 0.2327 - 3896 B
StringArray_aweXpect 1,834.4 ns 13.85 ns 12.95 ns 0.1526 - 2568 B
StringArray_FluentAssertions 1,328.9 ns 11.38 ns 10.09 ns 0.2480 - 4152 B
StringArrayInAnyOrder_aweXpect 2,446.5 ns 12.85 ns 11.39 ns 0.1640 - 2760 B
StringArrayInAnyOrder_FluentAssertions 127,692.9 ns 1,008.61 ns 943.46 ns 3.4180 - 61269 B

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 1, 2025

👽 Mutation Results

Mutation testing badge

aweXpect

Details
File Score Killed Survived Timeout No Coverage Ignored Compile Errors Total Detected Total Undetected Total Mutants

The final mutation score is NaN%

Coverage Thresholds: high:80 low:60 break:0

aweXpect.Core

Details
File Score Killed Survived Timeout No Coverage Ignored Compile Errors Total Detected Total Undetected Total Mutants

The final mutation score is NaN%

Coverage Thresholds: high:80 low:60 break:0

Copilot AI review requested due to automatic review settings November 1, 2025 15:22
@vbreuss vbreuss force-pushed the topic/document-mockolate branch from 636a043 to f0404c3 Compare November 1, 2025 15:22
@vbreuss vbreuss enabled auto-merge (squash) November 1, 2025 15:23
@vbreuss vbreuss disabled auto-merge November 1, 2025 15:25
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 16 out of 18 changed files in this pull request and generated 2 comments.

Comment thread Pipeline/Build.Pages.cs
Comment thread Pipeline/Build.Pages.cs
@vbreuss vbreuss enabled auto-merge (squash) November 1, 2025 15:28
Copilot AI review requested due to automatic review settings November 1, 2025 15:44
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 17 out of 19 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

Benchmarks/aweXpect.Benchmarks/HappyCaseBenchmarks.StringArrayInAnyOrder.cs:5

  • The TUnit import is no longer used since all TUnit benchmarks have been removed. This unused import should be removed to keep the code clean.
using TUnit.Assertions.Enums;

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Nov 1, 2025

@vbreuss vbreuss merged commit be643c6 into main Nov 1, 2025
21 checks passed
@vbreuss vbreuss deleted the topic/document-mockolate branch November 1, 2025 15:52
github-actions Bot added a commit that referenced this pull request Nov 1, 2025
github-actions Bot added a commit that referenced this pull request Nov 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants